
<html><head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta content="text/javascript" http-equiv="content-script-type">
<title>menu</title>
<link rel="stylesheet" type="text/css" href="candydoc/style.css">
<!--[if lt IE 7]><link rel="stylesheet" type="text/css" href="candydoc/ie56hack.css"><![endif]-->
<script language="JavaScript" src="candydoc/util.js" type="text/javascript"></script>
<script language="JavaScript" src="candydoc/tree.js" type="text/javascript"></script>
<script language="JavaScript" src="candydoc/explorer.js" type="text/javascript"></script>
</head><body>
<div id="tabarea"></div><div id="explorerclient"></div>
<div id="content"><script>explorer.initialize("menu");</script>
	<table class="content">
		<tr><td id="docbody"><h1>menu</h1><!-- Generated by Ddoc from ../modules/menu.d -->
<b>Authors:</b><br>
Jon "ylixir" Allen, ylixir@gmail.com
<br><br>
<b>License:</b><br>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
<br><br>

    The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
<br><br>

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
<br><br>


<script>explorer.outline.incSymbolLevel();</script>
<dl>
<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_fore</span>
<script>explorer.outline.addDecl('set_menu_fore');</script>

(MENU* <span class="funcparam">menu</span>, uint <span class="funcparam">attr</span>);
<br>uint 
<span class="currsymbol">menu_fore</span>
<script>explorer.outline.addDecl('menu_fore');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get the foreground (selected) attribute of <span class="funcparam">menu</span>.
<br><br>
<b>Returns:</b><br>
<i>E_OK</i>, <i>E_SYSTEM_ERROR</i>,
<i>E_BAD_ARGUMENT</i>.

<br><br>
<b>See Also:</b><br>
man menu_attributes
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_back</span>
<script>explorer.outline.addDecl('set_menu_back');</script>

(MENU* <span class="funcparam">menu</span>, uint <span class="funcparam">attr</span>);
<br>uint 
<span class="currsymbol">menu_back</span>
<script>explorer.outline.addDecl('menu_back');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get the background(unselected) attribute of <span class="funcparam">menu</span>.
<br><br>
<b>Returns:</b><br>
<i>E_OK</i>, <i>E_SYSTEM_ERROR</i>,
<i>E_BAD_ARGUMENT</i>.
<br><br>
<b>See Also:</b><br>
man menu_attributes
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_grey</span>
<script>explorer.outline.addDecl('set_menu_grey');</script>

(MENU* <span class="funcparam">menu</span>, uint <span class="funcparam">attr</span>);
<br>uint 
<span class="currsymbol">menu_grey</span>
<script>explorer.outline.addDecl('menu_grey');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get the grey(disabled) attribute of <span class="funcparam">menu</span>.
<br><br>
<b>Returns:</b><br>
<i>E_OK</i>, <i>E_SYSTEM_ERROR</i>,
<i>E_BAD_ARGUMENT</i>.

<br><br>
<b>See Also:</b><br>
man menu_attributes
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_pad</span>
<script>explorer.outline.addDecl('set_menu_pad');</script>

(MENU* <span class="funcparam">menu</span>, int <span class="funcparam">pad</span>);
<br>int 
<span class="currsymbol">menu_pad</span>
<script>explorer.outline.addDecl('menu_pad');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get padding character for the <span class="funcparam">menu</span>.
<br><br>
<b>Returns:</b><br>
<i>E_OK</i>, <i>E_SYSTEM_ERROR</i>,
<i>E_BAD_ARGUMENT</i>.

<br><br>
<b>See Also:</b><br>
man menu_attributes
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">pos_menu_cursor</span>
<script>explorer.outline.addDecl('pos_menu_cursor');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Move the cursor to the current position associated with the <span class="funcparam">menu</span>'s selected
item.
<br><br>
<b>Returns:</b><br>
<i>E_OK</i>, <i>E_SYSTEM_ERROR</i>,
<i>E_BAD_ARGUMENT</i>, <i>E_NOT_POSTED</i>.

<br><br>
<b>See Also:</b><br>
man menu_cursor
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">menu_driver</span>
<script>explorer.outline.addDecl('menu_driver');</script>

(MENU* <span class="funcparam">menu</span>, int <span class="funcparam">c</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Routine to handle <span class="funcparam">menu</span> input.
<br><br>
<b>See Also:</b><br>
man 
<span class="currsymbol">menu_driver</span>
<script>explorer.outline.addDecl('menu_driver');</script>


<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_LEFT_ITEM</span>
<script>explorer.outline.addDecl('REQ_LEFT_ITEM');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>move to item on the left
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_RIGHT_ITEM</span>
<script>explorer.outline.addDecl('REQ_RIGHT_ITEM');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>move to item on the right
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_UP_ITEM</span>
<script>explorer.outline.addDecl('REQ_UP_ITEM');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>move to item above
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_DOWN_ITEM</span>
<script>explorer.outline.addDecl('REQ_DOWN_ITEM');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>move to item below
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_SCR_ULINE</span>
<script>explorer.outline.addDecl('REQ_SCR_ULINE');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>scroll up a line
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_SCR_DLINE</span>
<script>explorer.outline.addDecl('REQ_SCR_DLINE');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>scroll down a line
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_SCR_DPAGE</span>
<script>explorer.outline.addDecl('REQ_SCR_DPAGE');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>scroll down a page
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_SCR_UPAGE</span>
<script>explorer.outline.addDecl('REQ_SCR_UPAGE');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>scroll up a page
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_FIRST_ITEM</span>
<script>explorer.outline.addDecl('REQ_FIRST_ITEM');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>go to the first item
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_LAST_ITEM</span>
<script>explorer.outline.addDecl('REQ_LAST_ITEM');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>go to the last item
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_NEXT_ITEM</span>
<script>explorer.outline.addDecl('REQ_NEXT_ITEM');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>go to the next item
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_PREV_ITEM</span>
<script>explorer.outline.addDecl('REQ_PREV_ITEM');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>go to the previous item
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_TOGGLE_ITEM</span>
<script>explorer.outline.addDecl('REQ_TOGGLE_ITEM');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>toggle an items selection
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_CLEAR_PATTERN</span>
<script>explorer.outline.addDecl('REQ_CLEAR_PATTERN');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>clear the menu pattern buffer
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_BACK_PATTERN</span>
<script>explorer.outline.addDecl('REQ_BACK_PATTERN');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>delete the last character from the pattern buffer
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_NEXT_MATCH</span>
<script>explorer.outline.addDecl('REQ_NEXT_MATCH');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>move to the next item matching the pattern match
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">
<span class="currsymbol">REQ_PREV_MATCH</span>
<script>explorer.outline.addDecl('REQ_PREV_MATCH');</script>

</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>move to the previous item matching the pattern match
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_format</span>
<script>explorer.outline.addDecl('set_menu_format');</script>

(MENU* <span class="funcparam">menu</span>, int <span class="funcparam">rows</span>, int <span class="funcparam">cols</span>);
<br>void 
<span class="currsymbol">menu_format</span>
<script>explorer.outline.addDecl('menu_format');</script>

(MENU* <span class="funcparam">menu</span>, int* <span class="funcparam">rows</span>, int* <span class="funcparam">cols</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get the max display size of a <span class="funcparam">menu</span>.
<br><br>
<b>See Also:</b><br>
man menu_format
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_item_init</span>
<script>explorer.outline.addDecl('set_item_init');</script>

(MENU* <span class="funcparam">menu</span>, void* function(MENU*) <span class="funcparam">func</span>);
<br>void* function(MENU*) 
<span class="currsymbol">item_init</span>
<script>explorer.outline.addDecl('item_init');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get the hook to be called when a <span class="funcparam">menu</span> posts and when the item
selection changes (after the change).
<br><br>
<b>See Also:</b><br>
man menu_hook
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_item_term</span>
<script>explorer.outline.addDecl('set_item_term');</script>

(MENU* <span class="funcparam">menu</span>, void* function(MENU*) <span class="funcparam">func</span>);
<br>void* function(MENU*) 
<span class="currsymbol">item_term</span>
<script>explorer.outline.addDecl('item_term');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get the hook to be called when a <span class="funcparam">menu</span> unposts and when the item
selection changes (before the change).
<br><br>
<b>See Also:</b><br>
man menu_hook
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_init</span>
<script>explorer.outline.addDecl('set_menu_init');</script>

(MENU* <span class="funcparam">menu</span>, void* function(MENU*) <span class="funcparam">func</span>);
<br>void* function(MENU*) 
<span class="currsymbol">menu_init</span>
<script>explorer.outline.addDecl('menu_init');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get the hook to be called when a <span class="funcparam">menu</span> posts and after the top row on the
<span class="funcparam">menu</span> changes.
<br><br>
<b>See Also:</b><br>
man menu_hook
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_term</span>
<script>explorer.outline.addDecl('set_menu_term');</script>

(MENU* <span class="funcparam">menu</span>, void* function(MENU*) <span class="funcparam">func</span>);
<br>void* function(MENU*) 
<span class="currsymbol">menu_term</span>
<script>explorer.outline.addDecl('menu_term');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get the hook to be called when a <span class="funcparam">menu</span> unposts and before the top row on
the <span class="funcparam">menu</span> changes.
<br><br>
<b>See Also:</b><br>
man menu_hook
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_items</span>
<script>explorer.outline.addDecl('set_menu_items');</script>

(MENU* <span class="funcparam">menu</span>, ITEM** <span class="funcparam">items</span>);
<br>ITEM** 
<span class="currsymbol">menu_items</span>
<script>explorer.outline.addDecl('menu_items');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get array of <span class="funcparam">menu</span> <span class="funcparam">items</span> associated with the <span class="funcparam">menu</span>.
Array is <b>null</b> terminated.
<br><br>
<b>See Also:</b><br>
man menu_items
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">item_count</span>
<script>explorer.outline.addDecl('item_count');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get the number of items in the <span class="funcparam">menu</span>.
<br><br>
<b>See Also:</b><br>
man menu_items
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_mark</span>
<script>explorer.outline.addDecl('set_menu_mark');</script>

(MENU* <span class="funcparam">menu</span>, char* <span class="funcparam">mark</span>);
<br>char* 
<span class="currsymbol">menu_mark</span>
<script>explorer.outline.addDecl('menu_mark');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get the string used to <span class="funcparam">mark</span> the selected <span class="funcparam">menu</span> items.
<br><br>
<b>See Also:</b><br>
man menu_mark
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">MENU* 
<span class="currsymbol">new_menu</span>
<script>explorer.outline.addDecl('new_menu');</script>

(ITEM** <span class="funcparam">items</span>);
<br>int 
<span class="currsymbol">free_menu</span>
<script>explorer.outline.addDecl('free_menu');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Allocate/deallocate a new menu.
<br><br>
<b>See Also:</b><br>
man menu_new
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_opts</span>
<script>explorer.outline.addDecl('set_menu_opts');</script>

(MENU* <span class="funcparam">menu</span>, OPTIONS <span class="funcparam">opts</span>);
<br>int 
<span class="currsymbol">menu_opts_on</span>
<script>explorer.outline.addDecl('menu_opts_on');</script>

(MENU* <span class="funcparam">menu</span>, OPTIONS <span class="funcparam">opts</span>);
<br>int 
<span class="currsymbol">menu_opts_off</span>
<script>explorer.outline.addDecl('menu_opts_off');</script>

(MENU* <span class="funcparam">menu</span>, OPTIONS <span class="funcparam">opts</span>);
<br>OPTIONS 
<span class="currsymbol">menu_opts</span>
<script>explorer.outline.addDecl('menu_opts');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Sets/gets <span class="funcparam">menu</span> option bits.
<br><br>
<b>See Also:</b><br>
man menu_opts
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_pattern</span>
<script>explorer.outline.addDecl('set_menu_pattern');</script>

(MENU* <span class="funcparam">menu</span>, char* <span class="funcparam">pattern</span>);
<br>char* 
<span class="currsymbol">menu_pattern</span>
<script>explorer.outline.addDecl('menu_pattern');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get the <span class="funcparam">pattern</span> match buffer for the <span class="funcparam">menu</span>.
<br><br>
<b>See Also:</b><br>
man menu_pattern
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">post_menu</span>
<script>explorer.outline.addDecl('post_menu');</script>

(MENU* <span class="funcparam">menu</span>);
<br>int 
<span class="currsymbol">unpost_menu</span>
<script>explorer.outline.addDecl('unpost_menu');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Display/erase a <span class="funcparam">menu</span>.
<br><br>
<b>See Also:</b><br>
man man menu_post
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">char* 
<span class="currsymbol">menu_request_name</span>
<script>explorer.outline.addDecl('menu_request_name');</script>

(int <span class="funcparam">request</span>);
<br>int 
<span class="currsymbol">menu_request_by_name</span>
<script>explorer.outline.addDecl('menu_request_by_name');</script>

(char* <span class="funcparam">name</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Gets printable name of a <span class="funcparam">request</span> code, or visa versa
<br><br>
<b>See Also:</b><br>
man menu_requestname
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_spacing</span>
<script>explorer.outline.addDecl('set_menu_spacing');</script>

(MENU* <span class="funcparam">menu</span>, int <span class="funcparam">spc_description</span>, int <span class="funcparam">spc_rows</span>, int <span class="funcparam">spc_columns</span>);
<br>int 
<span class="currsymbol">menu_spacing</span>
<script>explorer.outline.addDecl('menu_spacing');</script>

(MENU* <span class="funcparam">menu</span>, int* <span class="funcparam">spc_description</span>, int* <span class="funcparam">spc_rows</span>, int* <span class="funcparam">spc_columns</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/retrieve the spacing information for the <span class="funcparam">menu</span>.
<br><br>
<b>See Also:</b><br>
man menu_spacing
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_userptr</span>
<script>explorer.outline.addDecl('set_menu_userptr');</script>

(MENU* <span class="funcparam">menu</span>, void* <span class="funcparam">userptr</span>);
<br>void* 
<span class="currsymbol">menu_userptr</span>
<script>explorer.outline.addDecl('menu_userptr');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/retrieve the user pointer for the <span class="funcparam">menu</span>
<br><br>
<b>See Also:</b><br>
man menu_userptr
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_menu_win</span>
<script>explorer.outline.addDecl('set_menu_win');</script>

(MENU* <span class="funcparam">menu</span>, WINDOW* <span class="funcparam">win</span>);
<br>WINDOW* 
<span class="currsymbol">menu_win</span>
<script>explorer.outline.addDecl('menu_win');</script>

(MENU* <span class="funcparam">menu</span>);
<br>int 
<span class="currsymbol">set_menu_sub</span>
<script>explorer.outline.addDecl('set_menu_sub');</script>

(MENU* <span class="funcparam">menu</span>, WINDOW* <span class="funcparam">sub</span>);
<br>WINDOW* 
<span class="currsymbol">menu_sub</span>
<script>explorer.outline.addDecl('menu_sub');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get/set the windows associated with the menus.
<br><br>
<b>See Also:</b><br>
man menu_win
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">scale_menu</span>
<script>explorer.outline.addDecl('scale_menu');</script>

(MENU* <span class="funcparam">menu</span>, int* <span class="funcparam">rows</span>, int* <span class="funcparam">columns</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get the minimum required size of window for the <span class="funcparam">menu</span>.
<br><br>
<b>See Also:</b><br>
man menu_win
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_current_item</span>
<script>explorer.outline.addDecl('set_current_item');</script>

(MENU* <span class="funcparam">menu</span>, ITEM* <span class="funcparam">item</span>);
<br>ITEM* 
<span class="currsymbol">current_item</span>
<script>explorer.outline.addDecl('current_item');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get/set the current <span class="funcparam">menu</span> <span class="funcparam">item</span>.
<br><br>
<b>See Also:</b><br>
man mitem_current
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_top_row</span>
<script>explorer.outline.addDecl('set_top_row');</script>

(MENU* <span class="funcparam">menu</span>, int <span class="funcparam">row</span>);
<br>int 
<span class="currsymbol">top_row</span>
<script>explorer.outline.addDecl('top_row');</script>

(MENU* <span class="funcparam">menu</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set the item that is the top <span class="funcparam">row</span> of the <span class="funcparam">menu</span>.
<br><br>
<b>See Also:</b><br>
man mitem_current
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">item_index</span>
<script>explorer.outline.addDecl('item_index');</script>

(ITEM* <span class="funcparam">item</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get the index of the <span class="funcparam">item</span> in the menu.
<br><br>
<b>See Also:</b><br>
man mitem_current
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">char* 
<span class="currsymbol">item_name</span>
<script>explorer.outline.addDecl('item_name');</script>

(ITEM* <span class="funcparam">item</span>);
<br>char* 
<span class="currsymbol">item_description</span>
<script>explorer.outline.addDecl('item_description');</script>

(ITEM* <span class="funcparam">item</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get the name and description of the <span class="funcparam">item</span>.
<br><br>
<b>See Also:</b><br>
man mitem_name
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">ITEM* 
<span class="currsymbol">new_item</span>
<script>explorer.outline.addDecl('new_item');</script>

(char* <span class="funcparam">name</span>, char* <span class="funcparam">description</span>);
<br>int 
<span class="currsymbol">free_item</span>
<script>explorer.outline.addDecl('free_item');</script>

(ITEM* <span class="funcparam">item</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Allocate/deallocate a menu item.
<br><br>
<b>See Also:</b><br>
man mitem_new
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_item_opts</span>
<script>explorer.outline.addDecl('set_item_opts');</script>

(ITEM* <span class="funcparam">item</span>, OPTIONS <span class="funcparam">opts</span>);
<br>int 
<span class="currsymbol">item_opts_on</span>
<script>explorer.outline.addDecl('item_opts_on');</script>

(ITEM* <span class="funcparam">item</span>, OPTIONS <span class="funcparam">opts</span>);
<br>int 
<span class="currsymbol">item_opts_off</span>
<script>explorer.outline.addDecl('item_opts_off');</script>

(ITEM* <span class="funcparam">item</span>, OPTIONS <span class="funcparam">opts</span>);
<br>OPTIONS 
<span class="currsymbol">item_opts</span>
<script>explorer.outline.addDecl('item_opts');</script>

(ITEM* <span class="funcparam">item</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Set/get an items option bits
<br><br>
<b>See Also:</b><br>
man mitem_opts
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_item_userptr</span>
<script>explorer.outline.addDecl('set_item_userptr');</script>

(ITEM* <span class="funcparam">item</span>, void* <span class="funcparam">userptr</span>);
<br>void* 
<span class="currsymbol">item_userptr</span>
<script>explorer.outline.addDecl('item_userptr');</script>

(ITEM* <span class="funcparam">item</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get set the user pointer associated with the <span class="funcparam">item</span>.
<br><br>
<b>See Also:</b><br>
man mitem_userptr
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">int 
<span class="currsymbol">set_item_value</span>
<script>explorer.outline.addDecl('set_item_value');</script>

(ITEM* <span class="funcparam">item</span>, bool <span class="funcparam">value</span>);
<br>bool 
<span class="currsymbol">item_value</span>
<script>explorer.outline.addDecl('item_value');</script>

(ITEM* <span class="funcparam">item</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>Get set whether an <span class="funcparam">item</span> in a multivalued menu is selected or not.
<br><br>
<b>See Also:</b><br>
man mitem_value
<br><br>

</dd>

<script>explorer.outline.writeEnabled = true;</script>
<dt><span class="decl">bool 
<span class="currsymbol">item_visible</span>
<script>explorer.outline.addDecl('item_visible');</script>

(ITEM* <span class="funcparam">item</span>);
</span></dt>
<script>explorer.outline.writeEnabled = false;</script>


<dd>See whether the <span class="funcparam">item</span> is visible or not.
<br><br>
<b>See Also:</b><br>
man mitem_visible
<br><br>

</dd>
</dl>
<script>explorer.outline.decSymbolLevel();</script>


</td></tr>
		<tr><td id="docfooter">
			Page was generated with
			<img src="candydoc/img/candydoc.gif" style="vertical-align:middle; position:relative; top:-1px">
			on Sat Oct 25 15:39:19 2008

		</td></tr>
	</table>
</div>
<script></script>
</body></html>


